home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Games / xboing / README.install < prev    next >
Text File  |  1995-07-14  |  9KB  |  246 lines
  1. XBoing Installation
  2. ===================
  3.  
  4. Updated: 27th August 1993
  5.  
  6. Requirements
  7. ------------
  8.  
  9. - You must be using X11R4 or X11R5. It may work on X11R3 but cannot test it!
  10. - You must have the XPM pixmap library. The XPM library can be obtained from
  11.   the following sites:-
  12.  
  13.   avahi.inria.fr (138.96.24.30)     - Latest revision. (Europe)     V3.2g
  14.     - in /pub/xpm
  15.   ftp.x.org (18.24.0.12)            - Latest revision. (America)    V3.2g
  16.     - in /contrib
  17.   archie.au (139.130.4.6)           - Latest revision. (Australia)  V3.2g
  18.     - in /X11/contrib
  19.  
  20.   The author of XPM is lehors@sophia.inria.fr - BULL Research FRANCE 
  21.   I suggest you use 3.2g as it has had the best reports. 3.2f may have some
  22.   problems but works for me!
  23.  
  24. - v1.6 has now been compiled and I've be told  works on the following machines,
  25.  
  26.     + SunOS 4.1.2 5 sun4c/sun4m
  27.     + SunOS Solaris 2.2 LX
  28.     + IRIX 4.0.5G 12171207 IP7
  29.     + SGI 310/GTX
  30.     + HP 9000/720 HP-UX 8.07
  31.     + DEC 2100
  32.     + Coherent on i486/386!
  33.     + NCR 3000
  34.     + DEC OSF/1 AXP
  35.     + DECstation 5000/133 ULTRIX 4.2/4.3 0 RISC
  36.     + AIX 3.2.3e rs6000/350
  37.     + NetBSD on i486
  38.     + Linux on i486.
  39.     + Intel 486 ESIX 4.0.4 X11R4
  40.  
  41. - You must have a COLOUR display. Sorry to all those B&W dudes. I'll look 
  42.   into greyscale.
  43.  
  44. - An ANSI compiler would be nicer however I spent ages changing code with
  45.   all those lovely #ifdefs so you can use a non-ansi compiler. :-)
  46.  
  47. - This game DOES NOT need Motif or Xt or anything except pure XLib.
  48.  
  49. - The xnews Sun X server is NOT the quickest with this game. Be warned.
  50.  
  51.  
  52. Makefiles
  53. ---------
  54.  
  55. Included in this package is an Imakefile which generates a Makefile that will
  56. compile XBoing using your system setup. For those people without imake, or
  57. who can't get it to compile, a Makefile.std is also included. 
  58.  
  59.  
  60. Compilation
  61. -----------
  62.  
  63. Edit the Imakefile or the Makefile.std and change the default compiler to
  64. your compiler. Also change the compiler flags if necessary. 
  65.  
  66. Change the $(XBOING_DIR) to point to the place where xboing is to be 
  67. installed. In that directory xboing will create the highscore file and also
  68. place the level data and sound data.
  69.  
  70. NOTE: The user can now specify the sounds, level and highscore file locations
  71.       as environment variables. They are :-
  72.  
  73. XBOING_SCORE_FILE = the highscore file to be used.
  74. XBOING_LEVELS_DIR = the directory containing the levels.
  75. XBOING_SOUND_DIR  = the directory containing the sounds.
  76.  
  77. Also set the AUDIO_AVAILABLE flag to True or False to enable the audio in
  78. the game if possible. You may want to disable audio for everyone even if it
  79. is available. ie: universities.
  80.  
  81. Check the audio directory and see if audio is supported by xboing. Then check
  82. the Imakefile and see if it will automatically use the correct audio source.
  83. If not then change the default NOaudio.c to the one you want. For NCD & RPLAY
  84. users that's what you'll have to do. Don't forget to set the AUDIO_LIB and the
  85. AUDIO_INCLUDE variables.
  86.  
  87.     LINUXaudio.c    - SoundBlaster support on Linux for PC.
  88.     RPLAYaudio.c    - Support for the rplay sound system.
  89.     SUNaudio.c      - Sun workstation audio 
  90.     NCDaudio.c      - NCD X terminal NCDaudio support. See below.
  91.     HPaudio.c       - HP audio which is .au format?
  92.     NOaudio.c       - Default - no audio support file.
  93.     AFaudio.c       - Audiofile sound server. See below.
  94.  
  95. The default will be no audio at all. ie: NOaudio.c
  96.  
  97.  
  98. Audiofile Sound Server
  99. ----------------------
  100.  
  101. Also, the Imakefile needs an "-lAF -lAFUtil" added to it for AudioFile.
  102. -I<audiofileroot>/AF/AFlib.h -L<audiofileroot>/AF/lib
  103.  
  104.  
  105. NCD Audio Server or NetAudio
  106. ----------------------------
  107.  
  108. Needs -laudio -L<ncdaudiolibdir> -I<ncdincludedir>
  109.  
  110. Rplay sound system
  111. ------------------
  112.  
  113. ?
  114.  
  115.  
  116.  
  117. Please work on NOaudio.c if you have another machine that you want to post
  118. the sound too. Note that I am not going to support and other file format than
  119. .au as I'll have sound files everywhere. :-)
  120.  
  121. **************************************************************************
  122. See the troubleshooting bit near the end of the doco if you have problems.
  123. **************************************************************************
  124.  
  125. If you have imake, type:
  126.  
  127.     xmkmf
  128.     make depend
  129.     make all
  130.  
  131. X11R5 users can type 'xmkmf -a ; make all' if they like.
  132.  
  133. If you do not have imake, type:
  134.  
  135.     cp Makefile.std Makefile
  136.     make depend
  137.     make all
  138.  
  139.  
  140. Installation
  141. ------------
  142.  
  143. Try 'xboing -setup' and see if the compilation has gone as you planned.
  144. This option will print out useful information about where xboing will look
  145. for its data files.
  146.  
  147. Please note that you must be root to install the game. If you are not root
  148. then you can just run XBoing from your own account.
  149.  
  150. Don't forget to set the $(XBOING_DIR) in the Makefile/Imakefile and re-compile
  151. if you don't like where it will be installed.
  152.  
  153. For imake users, type:
  154.  
  155.     make install             - install XBoing binary.
  156.     make install.man         - install the manual page.
  157.  
  158. If you do not have imake then you must first edit the Makefile.std to check
  159. that where you want the program to be installed.
  160.  
  161.     make install             - install XBoing binary.
  162.     make install.man         - install the manual page.
  163.     
  164. You should now have XBoing installed and it's manual page. If not, then please
  165. read README.problems.
  166.  
  167.  
  168. HighScore File
  169. --------------
  170.  
  171. It is automatically created and chmoded to 0666. There will also be a personal
  172. highscore file saved in each users account home directory. This keeps their
  173. personal highscores. If you have problems then touch one and chmod it to
  174. something that will work for you. ie: rw for all.
  175.  
  176. Global file is different as it now only contains one entry per person. ie:
  177. their highest score.
  178.  
  179. NOTE: **** The highscore file format has changed since v1.6. Any old ones 
  180.            will barf! Global files have one entry now. Just erase them please.
  181.  
  182. Copyright
  183. ---------
  184.  
  185. XBoing: 
  186.  
  187. /*****************************************************************************
  188.  
  189.           (c) Copyright 1993, Justin C. Kibell, All Rights Reserved
  190.                            email: jck@citri.edu.au
  191.  
  192.   Permission to use, copy, modify, and distribute this software and its
  193.   documentation without written agreement is hereby granted. You cannot sell 
  194.   this software without written permission from the author. This entire 
  195.   copyright notice must appear in all copies of this software.
  196.  
  197.   IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, 
  198.   SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF 
  199.   THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUTHOR HAS BEEN ADVISED 
  200.   OF THE POSSIBILITY OF SUCH DAMAGE.
  201.  
  202.   THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED 
  203.   TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
  204.   PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE 
  205.   AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, 
  206.   ENHANCEMENTS, OR MODIFICATIONS.
  207.  
  208.  *****************************************************************************/
  209.  
  210. Xpm:
  211.   ----------------------------------------------------------------------------
  212. /*
  213.  * Copyright 1990-93 GROUPE BULL
  214.  *
  215.  * Permission to use, copy, modify, and distribute this software and its
  216.  * documentation for any purpose and without fee is hereby granted, provided
  217.  * that the above copyright notice appear in all copies and that both that
  218.  * copyright notice and this permission notice appear in supporting
  219.  * documentation, and that the name of GROUPE BULL not be used in advertising
  220.  * or publicity pertaining to distribution of the software without specific,
  221.  * written prior permission.  GROUPE BULL makes no representations about the
  222.  * suitability of this software for any purpose.  It is provided "as is"
  223.  * without express or implied warranty.
  224.  *
  225.  * GROUPE BULL disclaims all warranties with regard to this software,
  226.  * including all implied warranties of merchantability and fitness,
  227.  * in no event shall GROUPE BULL be liable for any special,
  228.  * indirect or consequential damages or any damages
  229.  * whatsoever resulting from loss of use, data or profits,
  230.  * whether in an action of contract, negligence or other tortious
  231.  * action, arising out of or in connection with the use
  232.  * or performance of this software.
  233.  *
  234.  */
  235.  
  236. Arnaud LE HORS      BULL Research FRANCE -- Koala Project
  237.                     (XPM - X PixMap format version 2 & 3)
  238.     Internet:       lehors@sophia.inria.fr
  239. Surface Mail:       Arnaud LE HORS, INRIA - Sophia Antipolis,
  240.                     2004, route des Lucioles, 06565 Valbonne Cedex -- FRANCE
  241.  Voice phone:       (33) 93.65.77.71, Fax: (33) 93 65 77 66, Telex: 97 00 50 F
  242.   ----------------------------------------------------------------------------
  243.  
  244. -------------------------------------------------------------------------------
  245. Justin Kibell - jck@citri.edu.au - +61 3 282 2456 - Vic - Australia
  246.